home *** CD-ROM | disk | FTP | other *** search
/ Die Speccy' 97 / Die Speccy' 97.iso / amiga_system / the_aminet / comm / cnet / adsextract_101.lha / ADSeXtract.doc < prev    next >
Text File  |  1995-10-21  |  5KB  |  124 lines
  1.                               ADSeXtract v1.0
  2.  
  3.                        by Ray Akey (aka Heavy Metal)
  4.  
  5.           Written and debugged using the SAS/C Development System
  6.  
  7.  
  8. Changes CNetADSEx v1.01
  9. -----------------------
  10. 1. Added support for SYSDATA:ADS.args.  SYSDATA:ADS.ARGS should contain
  11.    your DEFAULT preferences for ADSeXtract.  for instance, if you commonly
  12.    use "ADSEXTRACT PAT *.ads FILESBBSNAME dh0:downloads/files.bbs DELFILENOTE"
  13.    then SYSDATA:ADS.ARGS should containn the following:
  14.    
  15.       PAT *.ads
  16.       FILESBBSNAME dh0:downloads/files.bbs
  17.       DELFILENOTE
  18.       
  19.    Note that the above can be simply placed on a single line in ADS.ARGS. I
  20.    have split it up for examples sake.
  21.  
  22. Changes ADSeXtract v1.01
  23. -----------------------
  24. 1. Added support for multiple "SHORT" patterns.  You can use this arg
  25.    (and associated data) as many times as you want.  ie:
  26.  
  27.       ADSEXTRACT SHORT short: SHORT desc:
  28.  
  29. 2. Added support for multiple "PAT" patterns.  Like SHORT, you can use this
  30.    arg and associated data as many times as you want.  ie:
  31.  
  32.       ADSEXTRACT PAT *.ads PAT *.readme
  33.  
  34.  
  35.  
  36. About the Program
  37. -----------------
  38. ADSeXtract is a tool to be used in extracting "short" descriptions from
  39. .ADS and .README style files.  It was originally designed for CNet SysOps
  40. and there is a special CNet/PFile utility included to aid in their running
  41. ADSeXtract whenever they "AO" files.  Is is NOT limited to CNet use though,
  42. as the command line arguments are what ultimately controls how the program
  43. behaves.  So without further ado..
  44.  
  45.  
  46. Installation
  47. ------------
  48. non-CNet Installation:
  49. 1. Copy ADSeXtract to a directory somewhere in your command "path".
  50. 2. Run the program with the appropriate arguments as described in the
  51.    section titled "CLI Args"
  52. 3. The extracted descriptions will be either saved to a "files.bbs" file
  53.    of your choice or simply echoed to stdio (current window), dependant
  54.    simply on the arguments that you supply on the command line.
  55.  
  56.  
  57. CNET Installation:
  58. 1. Copy ADSeXtract to your PFILES: directory.
  59. 2. Copy CNetADSeX to PFILES: also.
  60. 3. Edit BBSMENU and search for the section titled "4; ud/base"
  61. 4. Now search the section mentioned above for the line that says
  62.    "AO, Adopt Orphans".
  63. 5. Change the above mentioned line to say
  64.  
  65.       "AO, Adopt Orphans |{#2pfiles:system/CNetADSeX}
  66.  
  67.                           ^ left curly bracket (brace) is actually a CTRL-Q
  68.  
  69. 6. select the CNet CONTROL PANEL menu item "TEXT/MENU RELOAD"
  70. 7. Use the "AO" command and CNet will now ask you if you want to run
  71.    ADSeXtract before adopting orphans.  This is done BEFORE adoption
  72.    so that all descriptions will be in your desired FILES.BBS (or
  73.    whatever you call it) before adoption begins.
  74. 8. ADSeXtract will prompt you for "Additional arguments"..  See the
  75.    section of thiis document titled, "CLI Args" if you are unsure
  76.    what to enter.
  77. 9. THIS IS SUPER IMPORTANT!!! -> After "AO", when the CNet prompt for the
  78.    name of the files.bbs file comes up, you MUST enter the same filename
  79.    (WITH PATH!!) that you specified in the "FILESBBSNAME" argument of
  80.    ADSeXtract (see the section below for the FILESBBSNAME argument).  If
  81.    you don't supply a FULL PATH, CNet will attempt to look for it in the
  82.    directory that it is currently adopting files into.  ADSeXtract does not
  83.    handle this (yet).  You MUST include a PATH for files.bbs in both CNet
  84.    **AND** ADSeXtract if you want CNet to find the extracted descriptions.
  85.  
  86.  
  87. CLI Args
  88. --------
  89. ADSeXtract accepts a few CLI arguments to fine tune its operation.
  90.  
  91.    PAT/K  - the file pattern to match when searching for "README" files.
  92.             If you specify "*.ADS", ADSeXtract will look for files ending
  93.             with the extension ".ADS" and will then proceed to extract the
  94.             "SHORT:" description from those files.
  95.  
  96.    NOFILESBBS - tells ADSeXtract to echo it's output only to the screen/window
  97.                 and not to save its output to a file.
  98.  
  99.    FILESBBSNAME/K - The filename to save short descriptions/filenotes to.  All
  100.                     descriptions found will be saved to the filename you
  101.                     specify.
  102.  
  103.    SHORT - The text to look for in "readme/ADS" files that precedes the actual
  104.            short description.  This will usually be "SHORT:" but this option
  105.            is included for completeness. :)
  106.  
  107.    DELFILENOTE - tells ADSeXtract to delete the CURRENT filenote from the
  108.                  files that are described in ADS/README files.  CNet REQUIRES
  109.                  that you do this, or it will simply use the AmigaDOS filenote
  110.                  in the CNet short description, rather than using the
  111.                  extracted short description.
  112.  
  113.  
  114. The SYSDATA:ADS.DIRS file
  115. -------------------------
  116. This file MUST exist.  It is the file that contains the FULL path of all
  117. directories that you want ADSeXtract to search, one per line.
  118.  
  119. eg.
  120.  
  121.    udbase1:ADSMISC
  122.    udbase1:CLINKFILES
  123.    udbase1:FIDOFILES
  124.